Campaign Tags
- API Endpoints: -
/v2/wa/messages - Authentication: - This API requires Bearer token authentication.
- Method: -
POST - Payload: - The payload must be passed in the body as a JSON object. It should include a
metadataobject containingtags. Thecampaignandtemplatetags are optional and may be included either individually or together, based on the request.
Expecting tags in below format inside metadata:
{
"metadata": {
"tags": {
"campaign": [],
"template": []
}
}
}
- The
campaignandtemplatetags are optional. These can be included individually or both can be included as needed. - If
campaignortemplatetags are received, they should be passed as part of the "tags" field in the payload. - Any campaign tags received from the Conv API must be forwarded to the platform APIs for RCS and WA.
- Both
campaignandtemplatetags provided:
{
"metadata": {
"tags": {
"campaign": ["campaign_tag_value1", "campaign_tag_value2", "campaign_tag_value3" ],
"template": ["template_tag_value1", "template_tag_value2"]
}
}
}
- When only
campaigntag is provided:
{
"metadata": {
"tags": {
"campaign": ["campaign_tag_1"]
}
}
}
- When only
templatetag is provided:
{
"metadata": {
"tags": {
"template": ["template_tag_1"]
}
}
}
- Response: On a successful request, following response is received:
{
"success": "true",
"responseId": "<responseid>"
}